home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / fbu_100.zip / FBUTIL.DOC < prev    next >
Text File  |  1992-07-10  |  38KB  |  992 lines
  1.  
  2.  
  3.                ────────────────────────────────────────────────
  4.  
  5.                ▒▒▒▒▒▒▄ ▒▒▒▒▒▒▒▄ ▒▒▄ ▒▒▄ ▒▒▒▒▒▒▒▒▄ ▒▒▒▒▄ ▒▒▄
  6.                ▒▒█▀▀▀▀  ▒▒█▀▒▒█ ▒▒█ ▒▒█  ▀▀▒▒█▀▀▀  ▒▒█▀ ▒▒█
  7.                ▒▒▒▒▄    ▒▒▒▒▒█▀ ▒▒█ ▒▒█    ▒▒█     ▒▒█  ▒▒█
  8.                ▒▒█▀▀    ▒▒█▀▒▒█ ▒▒█▄▒▒█    ▒▒█     ▒▒█  ▒▒█
  9.                ▒▒█     ▒▒▒▒▒▒▒█ ▒▒▒▒▒▒█    ▒▒█    ▒▒▒▒█ ▒▒▒▒▒▒▄
  10.                 ▀▀      ▀▀▀▀▀▀▀  ▀▀▀▀▀▀     ▀▀     ▀▀▀▀  ▀▀▀▀▀▀
  11.                ────────────────────────────────────────────────
  12.                              The Files.Bbs utility
  13.                                  Version 1.00
  14.                            Bob Henderson, 1:3812/10
  15.                ────────────────────────────────────────────────
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.     ───────────────────────────────────────────────────────────────────────
  65.                            FBUTIL 1.00 Documentation
  66.     ───────────────────────────────────────────────────────────────────────
  67.  
  68.         FEATURES. . . . . . . . . . . . . . . . . . . . . . . . .   2
  69.  
  70.         REQUIREMENTS  . . . . . . . . . . . . . . . . . . . . . .   3
  71.  
  72.         LEGAL STUFF . . . . . . . . . . . . . . . . . . . . . . .   3
  73.  
  74.         COMMAND LINE SWITCHES . . . . . . . . . . . . . . . . . .   3
  75.  
  76.         CONFIGURATION FILE. . . . . . . . . . . . . . . . . . . .   5
  77.             Archiver. . . . . . . . . . . . . . . . . . . . . . .   5
  78.             BbsInfo . . . . . . . . . . . . . . . . . . . . . . .   5
  79.             CounterStyle. . . . . . . . . . . . . . . . . . . . .   6
  80.             DaysNew . . . . . . . . . . . . . . . . . . . . . . .   6
  81.             DefaultSort . . . . . . . . . . . . . . . . . . . . .   6
  82.             DefListFooter . . . . . . . . . . . . . . . . . . . .   6
  83.             DefListHeader . . . . . . . . . . . . . . . . . . . .   7
  84.             FileFooter. . . . . . . . . . . . . . . . . . . . . .   7
  85.             FileHeader. . . . . . . . . . . . . . . . . . . . . .   7
  86.             FileList. . . . . . . . . . . . . . . . . . . . . . .   8
  87.             ListAreas . . . . . . . . . . . . . . . . . . . . . .   8
  88.             ListExclude . . . . . . . . . . . . . . . . . . . . .   8
  89.             ListFooter. . . . . . . . . . . . . . . . . . . . . .   8
  90.             ListHeader. . . . . . . . . . . . . . . . . . . . . .   8
  91.             ListSecurity. . . . . . . . . . . . . . . . . . . . .   9
  92.             LogFile . . . . . . . . . . . . . . . . . . . . . . .   9
  93.             NewFlagChar . . . . . . . . . . . . . . . . . . . . .   9
  94.             NoFileFooters . . . . . . . . . . . . . . . . . . . .   9
  95.             NoFileHeaders . . . . . . . . . . . . . . . . . . . .   9
  96.             NoName. . . . . . . . . . . . . . . . . . . . . . . .   9
  97.             NoLongDesc. . . . . . . . . . . . . . . . . . . . . .  10
  98.             OptionalSort. . . . . . . . . . . . . . . . . . . . .  10
  99.             RegNumber . . . . . . . . . . . . . . . . . . . . . .  10
  100.             RemoveMissing . . . . . . . . . . . . . . . . . . . .  10
  101.             SkipAreas . . . . . . . . . . . . . . . . . . . . . .  10
  102.             SysopName . . . . . . . . . . . . . . . . . . . . . .  11
  103.             TextPath. . . . . . . . . . . . . . . . . . . . . . .  11
  104.             TopExclude. . . . . . . . . . . . . . . . . . . . . .  11
  105.             TopFiles. . . . . . . . . . . . . . . . . . . . . . .  11
  106.             TopSecurity . . . . . . . . . . . . . . . . . . . . .  11
  107.             UseCommas . . . . . . . . . . . . . . . . . . . . . .  11
  108.  
  109.         FILE LISTS. . . . . . . . . . . . . . . . . . . . . . . .  12
  110.  
  111.         TIPS AND HINTS. . . . . . . . . . . . . . . . . . . . . .  13
  112.  
  113.         REGISTERING . . . . . . . . . . . . . . . . . . . . . . .  13
  114.  
  115.         THE FUTURE. . . . . . . . . . . . . . . . . . . . . . . .  14
  116.  
  117.         ACKNOWLEDGEMENTS. . . . . . . . . . . . . . . . . . . . .  15
  118.  
  119.  
  120.  
  121.  
  122.     ───────────────────────────────────────────────────────────────────────
  123.     Bob Henderson (1:3812/10)                                       Page  1
  124.     ───────────────────────────────────────────────────────────────────────
  125.  
  126.     ───────────────────────────────────────────────────────────────────────
  127.                            FBUTIL 1.00 Documentation
  128.     ───────────────────────────────────────────────────────────────────────
  129.  
  130.     F E A T U R E S
  131.     ───────────────────────────────────────────────────────────────────────
  132.  
  133.     ■   Support for Superbbs, Quickbbs and Remote Access file areas.
  134.  
  135.     ■   Optionally produce headers for the files.bbs in each file area. {+}
  136.  
  137.     ■   Optionally produce footers for the files.bbs in each file area.
  138.  
  139.     ■   Allows for external headers and footers that you make.
  140.  
  141.     ■   File  areas  can  be  sorted  by  Name,  Date,  Size,  or amount of
  142.         downloads.
  143.  
  144.     ■   Each file area can be sorted differently. You could sort some areas
  145.         by date and others by name or whatever.
  146.  
  147.     ■   Optionally Remove missing files from the file lists.
  148.  
  149.     ■   Removes Duplicate file entries from file list.
  150.  
  151.     ■   Adds file counters to those files that do not have one.
  152.  
  153.     ■   Formats file counters to specified width ( up to 5 digits ).
  154.  
  155.     ■   Can be used to change file counters to another type.
  156.  
  157.     ■   Produce up to  20 file lists, each list can  contain either all the
  158.         files in an area or just new  files. File lists may also be defined
  159.         as having only certain areas in it.
  160.  
  161.     ■   Each file list can have a different header and footer.
  162.  
  163.     ■   File  lists  can  be  archived  with  most  any archiver. Supported
  164.         archive types are Zip, Arj, Pak, Arc, Lzh, and Zoo.
  165.  
  166.     ■   Produce  Top Files  and Top  Areas reports  in both  ASCII and  ANSI
  167.         format.
  168.  
  169.     ■   CD-ROM support for SuperBBS 1.16+ and QuickBBS 2.75+
  170.  
  171.     ■   Support for long descriptions up to 512 characters.
  172.  
  173.     ■   Support for Sbbs " >" extended descriptions.
  174.  
  175.     ■   Can convert extended " >" descriptions to one line format.
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.     ───────────────────────────────────────────────────────────────────────
  185.     Bob Henderson (1:3812/10)                                       Page  2
  186.     ───────────────────────────────────────────────────────────────────────
  187.  
  188.     ───────────────────────────────────────────────────────────────────────
  189.                            FBUTIL 1.00 Documentation
  190.     ───────────────────────────────────────────────────────────────────────
  191.  
  192.  
  193.     R E Q U I R E M E N T S
  194.     ───────────────────────────────────────────────────────────────────────
  195.  
  196.     ■   Any IBM PC compatible computer with at least 256k free memory.
  197.  
  198.     ■   MS-DOS (or compatible) 3.30 or later. Earlier versions may work.
  199.  
  200.     ■   At least Files=20 in your config.sys
  201.  
  202.     ■   Superbbs, Quickbbs or Remote Access BBS programs.
  203.  
  204.  
  205.     L E G A L   S T U F F
  206.     ───────────────────────────────────────────────────────────────────────
  207.  
  208.     Fbutil  is  provided  as  is,  with  no  warranty  of  any kind, either
  209.     expressed or implied.  Fbutil is only guaranteed to  occupy disk space.
  210.     You are free to copy and distribute the Fbutil archive freely, provided
  211.     no changes or additions are made to the package.
  212.  
  213.     Bob Henderson (The  Author) shall in no event be  held liable to you or
  214.     anyone else for  any damages of ANY kind,  incidental or consequential,
  215.     arising from the use or inability to use this program.
  216.  
  217.     All products by  Bob Henderson are trademarks and  are Copyright by Bob
  218.     Henderson. Other products and brand  names are trademarks and Copyright
  219.     by the respective holders.
  220.  
  221.  
  222.     C O M M A N D   L I N E   S W I T C H E S
  223.     ───────────────────────────────────────────────────────────────────────
  224.  
  225.     Executing  Fbutil without  any switches  will present  you with a small
  226.     display on the available switches and what each one does.
  227.  
  228.         /Anum           Process only  area number specified.  No file lists
  229.                         or top screens will be made.
  230.  
  231.         /Cfile          Use the named configuration  instead of the default
  232.                         Fbutil.Cfg.
  233.  
  234.         /Dfile          Display named  file as a  header. Use this  to test
  235.                         the appearance of your headers. Some default values
  236.                         will be placed in the meta-character info.
  237.  
  238.         /Lnum           Display  information   on  the  list   number  num.
  239.                         Information  displayed includes  name, file  areas,
  240.                         header and  footers to use. Use  /L0 to display all
  241.                         file areas.
  242.  
  243.  
  244.  
  245.  
  246.     ───────────────────────────────────────────────────────────────────────
  247.     Bob Henderson (1:3812/10)                                       Page  3
  248.     ───────────────────────────────────────────────────────────────────────
  249.  
  250.     ───────────────────────────────────────────────────────────────────────
  251.                            FBUTIL 1.00 Documentation
  252.     ───────────────────────────────────────────────────────────────────────
  253.  
  254.         /N              Do  not  modify  files.bbs.  Use  this  if  you are
  255.                         uncertain of how things  are going to be processed.
  256.                         The  All/New files  lists will  be created  and all
  257.                         temporary files will be left in your file areas.
  258.  
  259.         /P              Process  all  file  areas.  Reads configuration and
  260.                         following its rules it will process all file areas,
  261.                         create  All/New  file   list  and  Top  Files/Areas
  262.                         reports.
  263.  
  264.         /Soption        Use alternate sort option, only works when using /A
  265.                         switch  to process  one file  area. See DefaultSort
  266.                         configuration option for valid sort options.
  267.  
  268.         /T              Test  configuration  files.   This  will  read  the
  269.                         default or named (/C) configuration file and report
  270.                         its findings and any errors that might occur.
  271.  
  272.  
  273.     Examples ...
  274.  
  275.     Fbutil /A10         Process area 10 only.
  276.     Fbutil /A10 /N      Process area 10 but do not modify files.bbs.
  277.     Fbutil /A /S-NAME   Process area 10, sort by name in descending order.
  278.     Fbutil /P /N        Process  ALL  areas  defined   and  do  not  modify
  279.                         files.bbs
  280.     Fbutil /T           Test configuration files.
  281.     Fbutil /L0          Display all file areas in BBS configuration.
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.     ───────────────────────────────────────────────────────────────────────
  309.     Bob Henderson (1:3812/10)                                       Page  4
  310.     ───────────────────────────────────────────────────────────────────────
  311.  
  312.     ───────────────────────────────────────────────────────────────────────
  313.                            FBUTIL 1.00 Documentation
  314.     ───────────────────────────────────────────────────────────────────────
  315.  
  316.  
  317.     C O N F I G U R A T I O N   F I L E
  318.     ───────────────────────────────────────────────────────────────────────
  319.  
  320.     Any  line in  the configurations  file beginning  with a ; (semi-colon)
  321.     will be ignored.
  322.  
  323.     Parameters enclosed in <> are required.
  324.     Parameters enclosed in [] are optional.
  325.  
  326.     Throughout this configuration file it will refer to a parameter 'List'.
  327.     What List usually refers to is a  list of numbers. These numbers can be
  328.     separated by either  a , (comma) or a -  (dash). Numbers separated by a
  329.     comma are  treated individually while  numbers separated by  a dash are
  330.     treated as a range. Examples..
  331.  
  332.     "Areas 1,10,20" would translate to using areas 1, 10 and 20
  333.     "Areas 1-10,20" would translate to using areas 1 thru 10 and area 20
  334.     "Areas 1-10,20" would translate to using areas 1 thru 10 and area 20
  335.     "Areas 1-10-20" would probably not work!!!
  336.  
  337.     In all cases you can put areas that are not there. 1-200 would mean use
  338.     all areas but I doubt you have that many areas so it would only do what
  339.     you have.
  340.  
  341.  
  342.     ───────────────────────────────────────────────────────────────────────
  343.     Key word    : Archiver
  344.     Parameters  : <Type> [Move]
  345.     Example     : Archiver Arj Move
  346.  
  347.     Type can be one of the following..  ARC, ARJ, LZH, PAK, ZIP or ZOO. The
  348.     archiver must  be somewhere in  the path for  it to work.  The Optional
  349.     Move will move the file into the archive.
  350.  
  351.  
  352.     ───────────────────────────────────────────────────────────────────────
  353.     Key word    : BbsInfo
  354.     Parameters  : <BbsType> <Path>
  355.     Example     : BbsInfo Sbbs C:\Sbbs\
  356.  
  357.     Fbutil supports 3 types of BBS packages. SuperBBS 1.16+, QuickBBS 2.75+
  358.     and Remote  Access 1.10+. The Path  parameter would be the  path to the
  359.     Bbs  files.  At  the  moment  Fbutil  will  only  access  the file area
  360.     information files  of your Bbs. In  the Future I will  allow for use of
  361.     the standard Flsearch.Ctl text file.  Use the BbsType that matches your
  362.     system.
  363.  
  364.         SBBS for SuperBBS.
  365.         QBBS for QuickBBS.
  366.         RA for Remote Access.
  367.  
  368.  
  369.  
  370.     ───────────────────────────────────────────────────────────────────────
  371.     Bob Henderson (1:3812/10)                                       Page  5
  372.     ───────────────────────────────────────────────────────────────────────
  373.  
  374.     ───────────────────────────────────────────────────────────────────────
  375.                            FBUTIL 1.00 Documentation
  376.     ───────────────────────────────────────────────────────────────────────
  377.  
  378.     ───────────────────────────────────────────────────────────────────────
  379.     Key word    : CounterStyle
  380.     Parameters  : <counter>
  381.     Example     : CounterStyle (00)
  382.  
  383.     The counter you enter here is what  will show up in your file list. You
  384.     could  also  use  this  to  change  counters.  The  width is important,
  385.     entering [00000] will  make all your counters with  5 digits. [00] will
  386.     be 2  digits unless the number  will not fit in  which case the counter
  387.     would be  the width of the  number. If Fbutil cannot  find the brackets
  388.     you specified it will look for the following characters to replace.
  389.  
  390.         ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
  391.  
  392.  
  393.     ───────────────────────────────────────────────────────────────────────
  394.     Key word    : DaysNew
  395.     Parameters  : <number>
  396.     Example     : DaysNew  30
  397.  
  398.     This is the 'number'  of days to flag files as being  new. In All files
  399.     lists the  'NewFlagChar' will be placed  to the right of  the date. For
  400.     the new  files lists the days  determine which files will  be placed in
  401.     the list.
  402.  
  403.  
  404.     ───────────────────────────────────────────────────────────────────────
  405.     Key word    : DefaultSort
  406.     Parameters  : <SortType>
  407.     Example     : DefaultSort  NAME
  408.  
  409.     Use this to specify a default way to sort the files.bbs. The Default if
  410.     not specified is NOSORT. Valid SortTypes are..
  411.  
  412.         NAME        Sort in alphabetical order from 0-9, A-Z and so on.
  413.         DATE        Sort by file date, oldest to the newest.
  414.         SIZE        Sort by file size, smallest to largest.
  415.         DOWNLOADS   Sort by amount of downloads, least to most downloaded.
  416.  
  417.     You can also  put a - (dash) in  front of the SortType and  the sorting
  418.     will be reversed. -DATE would then become newest to oldest.
  419.  
  420.  
  421.     ───────────────────────────────────────────────────────────────────────
  422.     Key word    : DefListFooter
  423.     Parameters  : <path\name>
  424.     Example     : DefListFooter C:\Util\List.Hdr
  425.  
  426.     The file specified will be placed at the very end of your filelist just
  427.     before  'stat' screen.  Use ListFooter  in the  FileList definitions to
  428.     override the default.
  429.  
  430.  
  431.  
  432.     ───────────────────────────────────────────────────────────────────────
  433.     Bob Henderson (1:3812/10)                                       Page  6
  434.     ───────────────────────────────────────────────────────────────────────
  435.  
  436.     ───────────────────────────────────────────────────────────────────────
  437.                            FBUTIL 1.00 Documentation
  438.     ───────────────────────────────────────────────────────────────────────
  439.  
  440.     ───────────────────────────────────────────────────────────────────────
  441.     Key word    : DefListHeader
  442.     Parameters  : <path\name>
  443.     Example     : DefListHeader C:\Util\Availist.Hdr
  444.  
  445.     The  file  specified  will  be  placed  at  the  very  beginning of the
  446.     filelists  that you  creat. This  should contain  some info  about your
  447.     system. There  is no limit on  the size of the  file. Use ListHeader in
  448.     FileList definitions to override the default.
  449.  
  450.  
  451.     ───────────────────────────────────────────────────────────────────────
  452.     Key word    : FileFooter
  453.     Parameters  : <path\name>
  454.     Example     : FileFooter C:\Bin\Fbutil.Ftr
  455.  
  456.     <path\name> should point to a file that you want to replace the default
  457.     footer information.  The file can have  up to 20 lines  and include any
  458.     one of the codes which apply to the FileHeader.
  459.  
  460.  
  461.     ───────────────────────────────────────────────────────────────────────
  462.     Key word    : FileHeader
  463.     Parameters  : <path\name>
  464.     Example     : FileHeader C:\Bin\Fbutil.Hdr
  465.  
  466.     <path\name> should point to a file that you want to replace the default
  467.     header information.  The file can have  up to 20 lines  and include any
  468.     one of the following codes which will be translated.
  469.  
  470.         %A    Name of area.
  471.         %B    Total bytes in file area.
  472.         %D    Total downloads from area.
  473.         %F    Total files in area.
  474.         %K    Total Kilobytes in area.
  475.         %M    Current date, like 01-Jan-91.
  476.         %N    Area number.
  477.         %R    Registered to name.
  478.         %T    Current Time.
  479.         %Y    Day number of year.
  480.  
  481.     Using  the codes  as they  look  above  will place  only the  amount of
  482.     characters needed to display. You can use one of three format modifiers
  483.     to help when  drawing boxes and such. The three  characters are \/| and
  484.     allow for left justify, right justify and centering of the string. In a
  485.     example I'll use area name which is "New Uploads".
  486.  
  487.     Before: │ %\\\\\\\\\\\\\A │ %////////////A │ %|||||||||||||||||||||A │
  488.     After : │ New Uploads     │    New Uploads │       New Uploads       │
  489.  
  490.     Don't forget to  allow enough space for the  variable otherwise it will
  491.     be truncated to  fit.
  492.  
  493.  
  494.     ───────────────────────────────────────────────────────────────────────
  495.     Bob Henderson (1:3812/10)                                       Page  7
  496.     ───────────────────────────────────────────────────────────────────────
  497.  
  498.     ───────────────────────────────────────────────────────────────────────
  499.                            FBUTIL 1.00 Documentation
  500.     ───────────────────────────────────────────────────────────────────────
  501.  
  502.     ───────────────────────────────────────────────────────────────────────
  503.     Key word    : FileList
  504.     Parameters  : <path\name> [New]
  505.     Example     : FileList E:\Uploads\Allfiles.Lst
  506.  
  507.  
  508.     <path\name> is  the full path  and name of  the file list  to make. The
  509.     optional New  keyword would tell  Fbutil to only  put new files  in the
  510.     list. The  keyword FileList must be  specified before using any  of the
  511.     List?????? keywords. See also ListAreas and ListSecurity.
  512.  
  513.  
  514.     ───────────────────────────────────────────────────────────────────────
  515.     Key word    : ListAreas
  516.     Parameters  : <List>
  517.     Example     : ListAreas 1-200
  518.  
  519.     The  'List' of  areas will  be  placed  in current  'FileList' that  is
  520.     specified. Use  with ListExclude for  better flexibility. This  keyword
  521.     must be used with each 'FileList' keyword.
  522.  
  523.  
  524.     ───────────────────────────────────────────────────────────────────────
  525.     Key word    : ListExclude
  526.     Parameters  : <List>
  527.     Example     : ListExclude 1-200
  528.  
  529.     The 'List' of  areas will not be placed in  the current 'FileList'. You
  530.     should specify ListAreas before using this  keyword or it will not work
  531.     correctly.
  532.  
  533.  
  534.     ───────────────────────────────────────────────────────────────────────
  535.     Key word    : ListFooter
  536.     Parameters  : <path\name>
  537.     Example     : ListFooter C:\Bin\Allfiles.Ftr
  538.  
  539.     <path\name> should point to a file that will be appended to the current
  540.     'FileList'.  This  option  overrides  the  DefListFooter  only  for the
  541.     FileList it applies to.
  542.  
  543.  
  544.     ───────────────────────────────────────────────────────────────────────
  545.     Key word    : ListHeader
  546.     Parameters  : <path\name>
  547.     Example     : ListHeader C:\Bin\Allfiles.Hdr
  548.  
  549.     <path\name> would  be the file  to place at  the very beginning  of the
  550.     current 'FileList'.  This option overrides  the DefListHeader only  for
  551.     the FileList it applies to.
  552.  
  553.  
  554.  
  555.  
  556.     ───────────────────────────────────────────────────────────────────────
  557.     Bob Henderson (1:3812/10)                                       Page  8
  558.     ───────────────────────────────────────────────────────────────────────
  559.  
  560.     ───────────────────────────────────────────────────────────────────────
  561.                            FBUTIL 1.00 Documentation
  562.     ───────────────────────────────────────────────────────────────────────
  563.  
  564.     ───────────────────────────────────────────────────────────────────────
  565.     Key word    : ListSecurity
  566.     Parameters  : <number>
  567.     Example     : ListSecurity 20
  568.  
  569.     <number> is the maximum security level in which the file area qualifies
  570.     to be placed in the current  'FileList'. This keyword must be used with
  571.     each 'FileList' keyword.
  572.  
  573.  
  574.     ───────────────────────────────────────────────────────────────────────
  575.     Key word    : LogFile
  576.     Parameters  : <path\name>
  577.     Example     : LogFile C:\Sbbs\N2\System.Log
  578.  
  579.     Enabling this will cause Fbutil to write to a logfile. Not much info is
  580.     put  in there  except for  Fatal Errors,  Removed or  Missing Files and
  581.     Start and End times.
  582.  
  583.  
  584.     ───────────────────────────────────────────────────────────────────────
  585.     Key word    : NewFlagChar
  586.     Parameters  : <char>
  587.     Example     : NewFlagChar ■
  588.  
  589.     Specify  what character  to use  to signify  a new  file that meets the
  590.     'DaysNew' criteria. The default character is '*'.
  591.  
  592.  
  593.     ───────────────────────────────────────────────────────────────────────
  594.     Key word    : NoFileFooters
  595.     Parameters  : <List>
  596.     Example     : NoFileFooters 1-200
  597.  
  598.     The 'List'  of areas will not  have the footer placed  at the bottom of
  599.     the  files.bbs. This  option is  only valid  if you  have specified the
  600.     FileFooter keyword.
  601.  
  602.     ───────────────────────────────────────────────────────────────────────
  603.     Key word    : NoFileHeaders
  604.     Parameters  : <List>
  605.     Example     : NoFileHeaders 1-200
  606.  
  607.     The 'List' of areas will not have the header placed in the files.bbs.
  608.  
  609.     ───────────────────────────────────────────────────────────────────────
  610.     Key word    : NoName
  611.     Parameters  : none
  612.     Example     : NoName
  613.  
  614.     Enabling this  option will keep your  name out of the  file lists. This
  615.     only works in registered versions.
  616.  
  617.  
  618.     ───────────────────────────────────────────────────────────────────────
  619.     Bob Henderson (1:3812/10)                                       Page  9
  620.     ───────────────────────────────────────────────────────────────────────
  621.  
  622.     ───────────────────────────────────────────────────────────────────────
  623.                            FBUTIL 1.00 Documentation
  624.     ───────────────────────────────────────────────────────────────────────
  625.  
  626.     ───────────────────────────────────────────────────────────────────────
  627.     Key word    : NoLongDesc
  628.     Parameters  : none
  629.     Example     : NoLongDesc
  630.  
  631.     This  will use  the extended  file descriptions  using a  ' >' on lines
  632.     after the  file name. Normally all  file descriptions are on  one line.
  633.     This allows for  very long descriptions when using  ' >' extended info.
  634.     You  can  also  change  this   option  and  Fbutil  will  correct  your
  635.     files.bbs's  to the  proper type.  NOTE: The  extended description must
  636.     start with a space and then a > symbol. If there are to many spaces the
  637.     line will be treated as a comment.
  638.  
  639.  
  640.     ───────────────────────────────────────────────────────────────────────
  641.     Key word    : OptionalSort
  642.     Parameters  : <SortType> <List>
  643.     Example     : OptionalSort -DATE 1
  644.  
  645.     Optionally sort  'List' file areas  in a different  order. This keyword
  646.     can  be  used  more  than  once  so  you  can have multiple sort styles
  647.     throughout the file areas.
  648.  
  649.  
  650.     ───────────────────────────────────────────────────────────────────────
  651.     Key word    : RegNumber
  652.     Parameters  : <Registration number>
  653.     Example     : RegNumber 22231434343123323321
  654.  
  655.     If you have registered Fbutil you  can put your own registration number
  656.     here. The number  must be 20 characters long so  please put all leading
  657.     and trailing zeros.
  658.  
  659.  
  660.     ───────────────────────────────────────────────────────────────────────
  661.     Key word    : RemoveMissing
  662.     Parameters  : none
  663.     Example     : RemoveMissing
  664.  
  665.     Enabling this  option will remove  missing files from  your listing. If
  666.     the LogFile is enabled the file  name and description will be placed in
  667.     the log file.
  668.  
  669.  
  670.     ───────────────────────────────────────────────────────────────────────
  671.     Key word    : SkipAreas
  672.     Parameters  : <List>
  673.     Example     : SkipAreas 78-200
  674.  
  675.     The  'List' of  areas here  will not  be included  in any  list or  top
  676.     report. In fact  Fbutil will not even touch the  listed areas. Use this
  677.     if  you do  not want  Fbutil to  process CD-Rom  Areas or  invalid file
  678.     areas.
  679.  
  680.     ───────────────────────────────────────────────────────────────────────
  681.     Bob Henderson (1:3812/10)                                       Page 10
  682.     ───────────────────────────────────────────────────────────────────────
  683.  
  684.     ───────────────────────────────────────────────────────────────────────
  685.                            FBUTIL 1.00 Documentation
  686.     ───────────────────────────────────────────────────────────────────────
  687.  
  688.     ───────────────────────────────────────────────────────────────────────
  689.     Key word    : SysopName
  690.     Parameters  : <Your Name>
  691.     Example     : SysopName Bob Henderson
  692.  
  693.     The  name here  will be  placed at  the very  bottom of  the file lists
  694.     unless the 'NoName' keyword is specified.
  695.  
  696.  
  697.     ───────────────────────────────────────────────────────────────────────
  698.     Key word    : TextPath
  699.     Parameters  : <path>
  700.     Example     : TextPath C:\Sbbs\Text\
  701.  
  702.     The path is where you would  want Fbutil to create the Fb_Areas.A?? and
  703.     Fb_Files.A?? information files. The first file is a listing of your top
  704.     file areas sorted by top downloads. The next is the top files listed by
  705.     downloads.
  706.  
  707.  
  708.     ───────────────────────────────────────────────────────────────────────
  709.     Key word    : TopExclude
  710.     Parameters  : <List>
  711.     Example     : TopExclude 1,30-40
  712.  
  713.     Fbutil can  exclude certain areas from  the Area and File  reports. See
  714.     the beginning of this section for information on the List parameter.
  715.  
  716.  
  717.     ───────────────────────────────────────────────────────────────────────
  718.     Key word    : TopFiles
  719.     Parameters  : <number>
  720.     Example     : TopFiles 100
  721.  
  722.     How many files do  you want in the Top Files report?  The Default is 30
  723.     files in the list. You can specify up to a maximum of 100 files.
  724.  
  725.  
  726.     ───────────────────────────────────────────────────────────────────────
  727.     Key word    : TopSecurity
  728.     Parameters  : <security>
  729.     Example     : TopSecurity 20
  730.  
  731.     TopSecurity refers the maximum security of  a file area that a Top Area
  732.     or File can be included in the list. A number between 0 and 65000 would
  733.     be valid.
  734.  
  735.  
  736.     ───────────────────────────────────────────────────────────────────────
  737.     Key word    : UseCommas
  738.     Parameters  : None
  739.     Example     : UseCommas
  740.  
  741.  
  742.     ───────────────────────────────────────────────────────────────────────
  743.     Bob Henderson (1:3812/10)                                       Page 11
  744.     ───────────────────────────────────────────────────────────────────────
  745.  
  746.     ───────────────────────────────────────────────────────────────────────
  747.                            FBUTIL 1.00 Documentation
  748.     ───────────────────────────────────────────────────────────────────────
  749.  
  750.     Enabling Commas option will make all  numbers that Fbutil prints to the
  751.     screen and your file lists comma delimited. 1234 becomes 1,234
  752.  
  753.     F I L E   L I S T S
  754.     ───────────────────────────────────────────────────────────────────────
  755.  
  756.     Fbutil can create up to 20 file  lists in a single pass. Each file list
  757.     can have different file areas and be New only type file lists. In order
  758.     to do this  you have to enter all  the info for each file  list in your
  759.     configuration file. There are some things you should know about the way
  760.     the configuration file should look like.
  761.  
  762.     1.  You MUST use the FileList key  word before using any of the List????
  763.         key words.
  764.  
  765.     2.  The List???? key words apply to the most recent FileList specified.
  766.  
  767.     3.  You must specify ListAreas and ListSecurity with each FileList.
  768.  
  769.     In summary the key words should be in this order to avoid any confusion
  770.     in the configuration.
  771.  
  772.         Required : FileList <path\name> [New]
  773.         Required : ListSecurity <security>
  774.         Required : ListAreas <List>
  775.         Optional : ListExclude <List>
  776.         Optional : ListHeader <path\name>
  777.         Optional : ListFooter <path\name>
  778.  
  779.     Here is  a sample setup  for two file  lists, the first  containing all
  780.     files and  the next containing just  new files. The List  would use the
  781.     default header and footer if specified elsewhere in the configuration.
  782.  
  783.     ;----------------------------------------
  784.     ; List #1
  785.     ;----------------------------------------
  786.     ;
  787.     FileList E:\Uploads\Allfiles.Lst
  788.     ListSecurity 20
  789.     ListAreas 1-78
  790.     ;
  791.     ;----------------------------------------
  792.     ; List #2
  793.     ;----------------------------------------
  794.     ;
  795.     FileList E:\Uploads\Newfiles.Lst New
  796.     ListSecurity 20
  797.     ListAreas 1-78
  798.     ;
  799.  
  800.     Both lists would contain areas 1 thru 78 with a maximum security of 20.
  801.  
  802.  
  803.  
  804.     ───────────────────────────────────────────────────────────────────────
  805.     Bob Henderson (1:3812/10)                                       Page 12
  806.     ───────────────────────────────────────────────────────────────────────
  807.  
  808.     ───────────────────────────────────────────────────────────────────────
  809.                            FBUTIL 1.00 Documentation
  810.     ───────────────────────────────────────────────────────────────────────
  811.  
  812.     T I P S   A N D   H I N T S
  813.     ───────────────────────────────────────────────────────────────────────
  814.  
  815.     ■   When picking areas for file lists or sort style you can use most of
  816.         the keywords more than once.  Like "SkipAreas 1" and "SkipAreas 10"
  817.         would be the same as SkipAreas 1,10.
  818.  
  819.     ■   If you have the need to  keep certain files from being moved around
  820.         in the files.bbs when sorting, you can put a comment line above and
  821.         below it and  the sort will not move them.  Basically it sorts from
  822.         beginning to  end unless there is  a comment in the  files.bbs then
  823.         the sort  is from beginning  to comment then  from comment to  end.
  824.         This is great  for those file areas that are  separated in to other
  825.         sections within that area.
  826.  
  827.     ■   Try sorting your directory in the  same order as the files.bbs. Use
  828.         Nortons DS.EXE (Directory Sort) or  similar utility. This will make
  829.         both Fbutil and the BBS run a little faster.
  830.  
  831.     ■   Use SkipAreas  to pass over the  empty or non-bbs file  areas. This
  832.         can speed things up a little.
  833.  
  834.  
  835.     R E G I S T R A T I O N
  836.     ───────────────────────────────────────────────────────────────────────
  837.  
  838.     Fbutil  is NOT  Public Domain  or  free  software, but  is released  as
  839.     Shareware. This means  that you may copy and  distribute Fbutil freely,
  840.     but  if you  intend to  continue  using  it after  a 30  day evaluation
  841.     period, you must  register your copy or stop  using it. By registering,
  842.     you are helping  and encouraging the author to  continue provide a good
  843.     piece of software.
  844.  
  845.     When you  register, you will be  sent (usually by crash  netmail, where
  846.     possible, or other arrangements) a  "key" to insert in your FBUTIL.CFG.
  847.     Registration  will enable  the NoName  and NoHeaders  keywords. It will
  848.     also place your name in the file lists instead of the "Evaluation Copy"
  849.     message. The  registration key will  work for all  future releases, and
  850.     possibly get you discounts on other programs that I release.
  851.  
  852.     There are three ways to register Fbutil.
  853.  
  854.     1.  Send  me money,  the more   the better!!..  Just kiddin  folks. The
  855.         normal registration fee  is $15.00 US currency. Details  are in the
  856.         REGISTER.TXT file.
  857.  
  858.     2.  If you are  a programmer and have something  of yours that requires
  859.         registration I  might be interested  in a swap  for registration of
  860.         your program. Send me a message and we can talk about it.
  861.  
  862.     3.  The last  resort. If  you cannot  afford it  but really  want to be
  863.         honest about it send me a postcard along with the REGISTER.TXT file
  864.         and I  will be glad  to help you  out. Make it  a nice postcard  or
  865.  
  866.     ───────────────────────────────────────────────────────────────────────
  867.     Bob Henderson (1:3812/10)                                       Page 13
  868.     ───────────────────────────────────────────────────────────────────────
  869.  
  870.     ───────────────────────────────────────────────────────────────────────
  871.                            FBUTIL 1.00 Documentation
  872.     ───────────────────────────────────────────────────────────────────────
  873.  
  874.         maybe a picture of the family on vacation in Tahiti. Your choice.
  875.  
  876.     Option number 3  might need some explanation. I  myself try to register
  877.     most programs that  I use, but I have  2 little boys to feed  and don't
  878.     always have  the money to do  so. I can see  where some sysops struggle
  879.     just to keep that extra phone line up  for their BBS. So I am trying to
  880.     be kind  to other fellow  sysops in allowing  them to at  least use the
  881.     program to its full potential but also letting me know that they really
  882.     do use it. In  this respect I can see if I need  to delve further in to
  883.     the Fbutil project.
  884.  
  885.     I am not a full time programmer and most money from my little utilities
  886.     will go back into my BBS to register some of the programs that I run.
  887.  
  888.  
  889.     T H E   F U T U R E
  890.     ───────────────────────────────────────────────────────────────────────
  891.  
  892.     Does it ever end ? Probably not. The future of is in your hands. I will
  893.     continue to work on  it but I need more than just  my ideas to put into
  894.     it. Throughout the  Beta stage I had some good  input from the testers.
  895.     You might ask them  but I think I added whatever they  wanted it to do.
  896.     Your suggestions would be greatly appreciated.  If you know me then you
  897.     know I  will try to  help just about  any one. No  problem is to  small
  898.     although some  may be to large,  like writing a mailer  because someone
  899.     can't get FD to work correctly.
  900.  
  901.     For the  future of Fbutil I  plan on making up  a configuration program
  902.     and dump the text  file setup. Allow for generic BBS with  the use of a
  903.     modified Flsearch.Ctl.  Be able to read  the mailer log and  update the
  904.     counters as it  goes. Make it share aware  so you can run it  on upload
  905.     areas after user  logs off ( multi-line ). And  a few other things that
  906.     might come soon.
  907.  
  908.  
  909.  
  910.  
  911.  
  912.  
  913.  
  914.  
  915.  
  916.  
  917.  
  918.  
  919.  
  920.  
  921.  
  922.  
  923.  
  924.  
  925.  
  926.  
  927.  
  928.     ───────────────────────────────────────────────────────────────────────
  929.     Bob Henderson (1:3812/10)                                       Page 14
  930.     ───────────────────────────────────────────────────────────────────────
  931.  
  932.     ───────────────────────────────────────────────────────────────────────
  933.                            FBUTIL 1.00 Documentation
  934.     ───────────────────────────────────────────────────────────────────────
  935.  
  936.  
  937.     A C K N O W L E D G E M E N T S
  938.     ───────────────────────────────────────────────────────────────────────
  939.  
  940.     I would like to thank the following  beta testers, who have, in one way
  941.     or another helped me get Fbutil in the shape that it is in.
  942.  
  943.     Aki Antman              SuperBBS HQ (2:220/620)
  944.     Bill Marshall           The Dead Pool (1:365/156)
  945.     James Kennemer          The Brazorian BBS (1:3812/20)
  946.     Jochen Ott              DO IT ! Mailbox (2:246/76)
  947.     Kazuyoshi Shinada       AVXIA BBS (6:730/9)
  948.     Ken Givens              SuperBBS Help (1:1/132)
  949.     Lee Anderson            MagicLand (1:139/650)
  950.     Steve Proctor           The Microline BBS (1:203/529)
  951.     Wayne Harris            Upspin BBS (1:3812/60)
  952.  
  953.     Special thanks go  to the my wife, Becky. For  understanding why I stay
  954.     up  so late  and make  the  phone  bill the  largest payment  on earth.
  955.  
  956.     Many thanks  to my two  little boys, William  and Sean. Who  managed to
  957.     always sit in my lap in press the right keys when I wanted them to.
  958.  
  959.     If I left anyone  out it is not because I wanted  to. Thanks to all who
  960.     helped in developing Fbutil.
  961.  
  962.  
  963.  
  964.  
  965.  
  966.  
  967.  
  968.  
  969.  
  970.  
  971.  
  972.  
  973.  
  974.  
  975.  
  976.  
  977.  
  978.  
  979.  
  980.  
  981.  
  982.  
  983.  
  984.  
  985.  
  986.  
  987.  
  988.  
  989.     ───────────────────────────────────────────────────────────────────────
  990.     Bob Henderson (1:3812/10)                                       Page 15
  991.     ───────────────────────────────────────────────────────────────────────
  992.